CRONO SDK 1.0.1
Crono device configuration functions.

Functions

CRONO_Return CRONO_SetSpadDeadTime (CRONO_H crono, int deadTimeNs)
 
CRONO_Return CRONO_GetSensorType (CRONO_H crono, CRONO_SensorType *sensorType)
 
CRONO_Return CRONO_ConfigSensor (CRONO_H crono, int activePixels, cronoBool half1Enable, cronoBool half2Enable, double *maxFrameStartFrequency)
 
CRONO_Return CRONO_GetActivePixels (CRONO_H crono, int *activePixels)
 
CRONO_Return CRONO_LoadCameraSettings (CRONO_H crono, CRONO_CameraSettings settings)
 
CRONO_Return CRONO_GetCameraSettings (CRONO_H crono, CRONO_CameraSettings *settings)
 
CRONO_Return CRONO_LoadSettingsFromFile (CRONO_H crono, char *path)
 
CRONO_Return CRONO_SaveSettingsToFile (CRONO_H crono, char *path)
 
CRONO_Return CRONO_ConfigAcquisition (CRONO_H crono, CRONO_PixelMode pixelMode, cronoBool framesEnable, cronoBool histogramsEnable, cronoBool timeTagsEnable, cronoBool liveEnable, cronoBool unused, const char *rawDataOutPath)
 

Detailed Description

Functions to configure various features of the Crono camera.

Function Documentation

◆ CRONO_ConfigAcquisition()

CRONO_Return CRONO_ConfigAcquisition ( CRONO_H  crono,
CRONO_PixelMode  pixelMode,
cronoBool  framesEnable,
cronoBool  histogramsEnable,
cronoBool  timeTagsEnable,
cronoBool  liveEnable,
cronoBool  unused,
const char *  rawDataOutPath 
)

configures the acquisition modes and selects the output data formats.

Data will be generated only for active formats. Please refer to the User Manual for more details about data formats. Please refer also to the sample program

See also
CRONO_SDK_Example.c for use cases.
Parameters
cronoHandle to an existing Crono object.
pixelModeDesired pixel mode, can be either counting or timing.
framesEnableIf true enables the generation of timing or counting frames. Use CRONO_GetFramesData() function to retrieve data.
histogramsEnableIf true enables the generation of histograms. Use CRONO_GetHistogramData() function to retrieve data.
timeTagsEnableIf true enables the generation of time tags. Use CRONO_GetTimeTagsData() function to retrieve data.
liveEnableIf true enables the generation of live data. If no other format is selected, the PureLive mode is enabled, which allows changing some of the settings during acquisition. Use CRONO_GetLiveData() function to retrieve data.
unusedFor future use. Value is ignored.
rawDataOutPathRaw data file path. Set this parameter to a non empty C string to enable automatic saving of raw data from the SDK in the specified file.
Returns
CRONO_Return
Examples
CRONO_SDK_Example.c.

◆ CRONO_ConfigSensor()

CRONO_Return CRONO_ConfigSensor ( CRONO_H  crono,
int  activePixels,
cronoBool  half1Enable,
cronoBool  half2Enable,
double *  maxFrameStartFrequency 
)

Configures the Crono spad array sensor region of interest, i.e.

configures the number of active pixels and enables/disables each sensor half on 128x1 sensors.

Parameters
cronoHandle to an existing Crono object.
activePixelsNumber of pixels to be activated. Valid values range from 1 to the number of pixels in the sensor (including limits). The maximum number of pixels is 64 for 8x8 arrays and 128 for 128x1 sensors.
half1EnableEnables the first half of the Crono sensor on 128x1 sensors. Refer to the Crono datasheet for further details.
half2EnableEnables the second half of the Crono sensor on 128x1 sensors. Refer to the Crono datasheet for further details.
maxFrameStartFrequencyPointer to a double that will contain the calculated maximum allowable frame start frequency with the given configuration. This value gives an upper limit to the frame rate configurable via CRONO_ConfigFrameStartInternal() or CRONO_ConfigFrameStartExternal().
Returns
CRONO_Return
Examples
CRONO_SDK_Example.c.

◆ CRONO_GetActivePixels()

CRONO_Return CRONO_GetActivePixels ( CRONO_H  crono,
int *  activePixels 
)

Gets the number of active pixels currently configured.

Parameters
cronoHandle to an existing Crono object.
activePixelsPointer to an int that will contain the number of active pixels.
Returns
CRONO_Return

◆ CRONO_GetCameraSettings()

CRONO_Return CRONO_GetCameraSettings ( CRONO_H  crono,
CRONO_CameraSettings settings 
)

Gets actual Crono settings and saves them in a user provided CRONO_CameraSettings struct passed by reference.

Parameters
cronoHandle to an existing Crono object.
settingsPointer to user-provided CRONO_CameraSettings struct to accomodate Crono settings.
Returns
CRONO_Return
Examples
CRONO_SDK_Example.c.

◆ CRONO_GetSensorType()

CRONO_Return CRONO_GetSensorType ( CRONO_H  crono,
CRONO_SensorType sensorType 
)

Retrieves the sensor type (128x1 or 8x8)

Parameters
cronoHandle to an existing Crono object.
sensorTypePointer to the retrieved Crono sensor type/format.
Returns
CRONO_Return

◆ CRONO_LoadCameraSettings()

CRONO_Return CRONO_LoadCameraSettings ( CRONO_H  crono,
CRONO_CameraSettings  settings 
)

Loads Crono settings from a CRONO_CameraSettings struct.

Overrides any configuration previously set via other functions.

Parameters
cronoHandle to an existing Crono object.
settingsUser-provided CRONO_CameraSettings struct.
Returns
CRONO_Return

◆ CRONO_LoadSettingsFromFile()

CRONO_Return CRONO_LoadSettingsFromFile ( CRONO_H  crono,
char *  path 
)

Loads Crono settings from a file.

Overrides any configuration previously set via other functions.

Parameters
cronoHandle to an existing Crono object.
pathFull path to the settings file to be read.
Returns
CRONO_Return
Examples
CRONO_SDK_Example.c.

◆ CRONO_SaveSettingsToFile()

CRONO_Return CRONO_SaveSettingsToFile ( CRONO_H  crono,
char *  path 
)

Saves current settings to file.

Parameters
cronoHandle to an existing Crono object.
pathFull path to the settings file to be written.
Returns
CRONO_Return
Examples
CRONO_SDK_Example.c.

◆ CRONO_SetSpadDeadTime()

CRONO_Return CRONO_SetSpadDeadTime ( CRONO_H  crono,
int  deadTimeNs 
)

Sets the SPADs dead time in ns.

Value applies to all pixels.

Parameters
cronoHandle to an existing Crono object.
deadTimeNsDead time value to be set expressed in nanoseconds. Valid values range from 40 nanoseconds to 150 nanoseconds (including limits).
Returns
CRONO_Return
Examples
CRONO_SDK_Example.c.